Padrões para nomenclatura de arquivos

Esse artigo padroniza a nomenclatura dos arquivos e formulários desenvolvidos em Delphi na KM&M Engenharia de Sistemas. O objetivo é facilitar a programação, manutenção e suporte dos sistemas existentes.

Nomenclatura dos Arquivos

Os arquivos que compõe uma DLL de sistemas da KM&M devem conter o alias com no máximo 4 (quatro) caracteres para identificação do módulo dentro de DLL.

Por exemplo:

· Cheque – “Chq”;

· Contas a Pagar – “Pga”;

· Contas a Receber – “Rcb”;

· Nota fiscal de E/S – “NFES”.

· Após o alias deve ser inserida uma descrição da funcionalidade do arquivo. Essa descrição deve ser separada pelo símbolo ”_”.

· Por exemplo:

· Cheque – “Chq_Emissao”; “Chq_Copia”; “Chq_Compensacao”; “Chq_Lista”; “Chq_Relatorio”.

· Contas a Pagar – “Pga_Lancamento”; “Pga_Amortizacao”; “Pga_Desconto”; “Pga_Lista”.

· Contas a Receber – “Rcb_Lancamento”; “Rcb_Amortizacao”; “Rcb_Acrescimo”; “Rcb_Lista”.

· Nota fiscal de E/S – “NFES_Emissao”; “NFES_Registro”; “NFES_Lista”.

Nomenclatura dos Formulários

A propriedade “Name” do formulário deve seguir a mesma regra da nomenclatura do arquivo. Já a propriedade “Caption” deve conter o módulo dentro da DLL seguido da descrição da funcionalidade.

Por exemplo:

Arquivo	Form.Name	Form.Caption
Chq_Emissao.pas	FormChq_Emissao	Cheque – Emissão de Cheques
Chq_Copia.pas	FormChq_Copia	Cheque – Cópia de Cheques
Pga_Lancamento.pas	FormPga_Lancamento	Contas a Pagar – Lançamento de Contas
Rcb_Amortizacao.pas	FormRcb_Amortizacao	Contas a Receber – Amortização de Contas
NFES_Lista.pas	FormNFES_Lista	Nota Fiscal E/S – Lista de Lançamentos

Arquivos e formulários de Localizar

Os arquivos de Localizar deverão respeitar outro critério:

· Serão armazenados na pasta Projetos\00-Padroes\Localizar;

· Todas as aplicações utilizarão os mesmos arquivos de Localizar, e estes estarão em um único lugar, evitando redundância e re-trabalho;

· Para a nomenclatura dos arquivos, deve ser respeitada a mesma regra utilizada nas dll’s de projetos normais;

· O alias dos arquivos será sempre o LCZ.

· Quanto à nomenclatura dos formulários, a propriedade “Name” do formulário deve seguir a mesma regra da nomenclatura do arquivo. Já a propriedade “Caption” deve ser composta de expressa “Localizar” acompanhada nome do registro que esta sendo localizado

Por exemplo:

Arquivo	Form.Name	Form.Caption
Lcz_Setor.pas	FormLcz_Setor	Localizar Setor
Lcz_Cheque_.pas	FormLcz_Cheque	Localizar Cheque
Lcz_ContasPagar.pas	FormLcz_ContasPagar	Localizar Lançamento de Contas a Pagar
Lcz_NFES.pas	FormLcz_NFES	Localizar Nota Fiscal de E/

Data Module

Toda DLL deve conter um Data Module com o nome do arquivo definido como DataModule.pas e a propriedade “Name” denominada “DM”.

REVISÕES		(Indique aqui o resumo das alterações executadas)
Data/Hora	Descrição		Alterado por	Revisado por
11/04/2005 00:00	Criação do artigo.		JCM	Equipe
07/08/2006 11:00	Alterações sugeridas conforme discussão GerenciaArquivo.xls.		JCM